<!DOCTYPE html>
<html>
<head>
	<meta charset="utf-8">

	<title>UVLogMessage Class Reference</title>

	<link rel="stylesheet" href="../css/style.css">
	<meta name="viewport" content="initial-scale=1, maximum-scale=1.4">
	<meta name="generator" content="appledoc 2.2.1 (build 1333)">
</head>
<body class="appledoc">
	<header>
		<div class="container" class="hide-in-xcode">
			
			<h1 id="library-title">
				<a href="../index.html">IJKMediaPlayer-static </a>
			</h1>

			<p id="developer-home">
				<a href="../index.html">UCloud</a>
			</p>
			
		</div>
	</header>

	<aside>
		<div class="container">
			<nav>
				<ul id="header-buttons" role="toolbar">
					<li><a href="../index.html">Index</a></li>
<li><a href="../hierarchy.html">Hierarchy</a></li>

					<li id="on-this-page" role="navigation">
						<label>
							On This Page

							<div class="chevron">
								<div class="chevy chevron-left"></div>
								<div class="chevy chevron-right"></div>
							</div>

							<select id="jump-to">
	<option value="top">Jump To&#133;</option>
	
	<option value="overview">Overview</option>
	

	
	
	<option value="tasks">Tasks</option>
	
	

	
	
	<optgroup label="Properties">
		
		<option value="//api/name/message">message</option>
		
	</optgroup>
	

	

	
	<optgroup label="Instance Methods">
		
		<option value="//api/name/init">- init</option>
		
		<option value="//api/name/initWithMessage:level:flag:context:file:function:line:tag:options:timestamp:">- initWithMessage:level:flag:context:file:function:line:tag:options:timestamp:</option>
		
	</optgroup>
	
	
</select>
						</label>
					</li>
				</ul>
			</nav>
		</div>
	</aside>

	<article>
		<div id="overview_contents" class="container">
			<div id="content">
				<main role="main">
					<h1 class="title">UVLogMessage Class Reference</h1>

					
					<div class="section section-specification"><table cellspacing="0"><tbody>
						<tr>
	<th>Inherits from</th>
	<td>NSObject</td>
</tr><tr>
	<th>Conforms to</th>
	<td>NSCopying</td>
</tr><tr>
	<th>Declared in</th>
	<td>UVLog.h</td>
</tr>
						</tbody></table></div>
					

                    
					
					<div class="section section-overview">
						<a title="Overview" name="overview"></a>
						<h2 class="subtitle subtitle-overview">Overview</h2>
						<p>The <code>UVLogMessage</code> class encapsulates information about the log <a href="#//api/name/message">message</a>.
If you write custom loggers or formatters, you will be dealing with objects of this class.</p>
					</div>
					
					

					
					
					<div class="section section-tasks">
						<a title="Tasks" name="tasks"></a>
						

						
						

						<div class="task-list">
							<div class="section-method">
	<a name="//api/name/init" title="init"></a>
	<h3 class="method-title"><code><a href="#//api/name/init">&ndash;&nbsp;init</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Default <code>init</code> for empty messages.</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>- (instancetype)init</code></div>

		    
			

			

			

			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">UVLog.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/initWithMessage:level:flag:context:file:function:line:tag:options:timestamp:" title="initWithMessage:level:flag:context:file:function:line:tag:options:timestamp:"></a>
	<h3 class="method-title"><code><a href="#//api/name/initWithMessage:level:flag:context:file:function:line:tag:options:timestamp:">&ndash;&nbsp;initWithMessage:level:flag:context:file:function:line:tag:options:timestamp:</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Standard <a href="#//api/name/init">init</a> method for a log <a href="#//api/name/message">message</a> object.
Used by the logging primitives. (And the macros use the logging primitives.)</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>- (instancetype)initWithMessage:(NSString *)<em>message</em> level:(UVLogLevel)<em>level</em> flag:(UVLogFlag)<em>flag</em> context:(NSInteger)<em>context</em> file:(NSString *)<em>file</em> function:(NSString *__null_unspecified)<em>function</em> line:(NSUInteger)<em>line</em> tag:(id __nullable)<em>tag</em> options:(UVLogMessageOptions)<em>options</em> timestamp:(NSDate *__nullable)<em>timestamp</em></code></div>

		    
			
			<div class="method-subsection arguments-section parameters">
				<h4 class="method-subtitle parameter-title">Parameters</h4>
				<table class="argument-def parameter-def">
				
					<tr>
						<th scope="row" class="argument-name"><code>message</code></th>
						<td><p>the <a href="#//api/name/message">message</a></p></td>
					</tr>
				
					<tr>
						<th scope="row" class="argument-name"><code>level</code></th>
						<td><p>the log <a href="#//api/name/level">level</a></p></td>
					</tr>
				
					<tr>
						<th scope="row" class="argument-name"><code>flag</code></th>
						<td><p>the log <a href="#//api/name/flag">flag</a></p></td>
					</tr>
				
					<tr>
						<th scope="row" class="argument-name"><code>context</code></th>
						<td><p>the <a href="#//api/name/context">context</a> (if any is defined)</p></td>
					</tr>
				
					<tr>
						<th scope="row" class="argument-name"><code>file</code></th>
						<td><p>the current <a href="#//api/name/file">file</a></p></td>
					</tr>
				
					<tr>
						<th scope="row" class="argument-name"><code>function</code></th>
						<td><p>the current <a href="#//api/name/function">function</a></p></td>
					</tr>
				
					<tr>
						<th scope="row" class="argument-name"><code>line</code></th>
						<td><p>the current code <a href="#//api/name/line">line</a></p></td>
					</tr>
				
					<tr>
						<th scope="row" class="argument-name"><code>tag</code></th>
						<td><p>potential <a href="#//api/name/tag">tag</a></p></td>
					</tr>
				
					<tr>
						<th scope="row" class="argument-name"><code>options</code></th>
						<td><p>a bitmask which supports UVLogMessageCopyFile and UVLogMessageCopyFunction.</p></td>
					</tr>
				
					<tr>
						<th scope="row" class="argument-name"><code>timestamp</code></th>
						<td><p>the log <a href="#//api/name/timestamp">timestamp</a></p></td>
					</tr>
				
				</table>
			</div>
			

			
			<div class="method-subsection return">
				<h4 class="method-subtitle parameter-title">Return Value</h4>
				<p>a new instance of a log <a href="#//api/name/message">message</a> model object</p>
			</div>
			

			

			
			<div class="method-subsection discussion-section">
				<h4 class="method-subtitle">Discussion</h4>
				<p>If you find need to manually create logMessage objects, there is one thing you should be aware of:</p>

<p>If no flags are passed, the method expects the <a href="#//api/name/file">file</a> and <a href="#//api/name/function">function</a> parameters to be string literals.
That is, it expects the given strings to exist for the duration of the object&rsquo;s lifetime,
and it expects the given strings to be immutable.
In other words, it does not copy these strings, it simply points to them.
This is due to the fact that <strong>FILE</strong> and <strong>FUNCTION</strong> are usually used to specify these parameters,
so it makes sense to optimize and skip the unnecessary allocations.
However, if you need them to be copied you may use the <a href="#//api/name/options">options</a> parameter to specify this.</p>
			</div>
			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">UVLog.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/message" title="message"></a>
	<h3 class="method-title"><code><a href="#//api/name/message">&nbsp;&nbsp;message</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>The log message</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>@property (readonly, nonatomic) NSString *message</code></div>

		    
			

			

			

			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">UVLog.h</code></p>
			</div>
			
			
		</div>
	</div>
</div>
						</div>
						
					</div>
					
					

                    
                    
          
				</main>

				<footer>
					<div class="footer-copyright">
						
						<p class="copyright">Copyright &copy; 2017 UCloud. All rights reserved. Updated: 2017-04-18</p>
						
						
						<p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1333)</a>.</p>
						
					</div>
				</footer>
			</div>
		</div>
	</article>

	<script src="../js/script.js"></script>
</body>
</html>